home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / util / misc / TMDock.lha / tmdock / TMDock.doc next >
Encoding:
Text File  |  1996-09-30  |  4.3 KB  |  160 lines
  1.                            TMDock V1.00
  2.                            ============
  3.  
  4.                         ©1996 Andreas Mair
  5.  
  6. *** INTRODUCTION ***
  7.  
  8. "TMDock" is a simple tool that builds Docks on any public screen by using
  9. the "toolmanager.library" and a simple settings file. After you run this
  10. tool it will open all Docks specified in the settings file and will wait
  11. until send it a "Ctrl+C".
  12.  
  13. This tool was developed for MusicManIII. But as you will see it will also
  14. work with other applications, too. If someone wants to include it in his
  15. program package I'd like to here of that. If it's a commercial or Share-
  16. ware package you must inform me (hey, don't you think about registering
  17. me for FREE? If this tool helps you, why not?).
  18.  
  19. If you have any suggestions on this tool, find any bugs or anything else,
  20. please contact me.
  21. If there is interest in making this tool better, why not?
  22.  
  23. The settings file is an ascii file that you can easily edit with any text
  24. editor that produces ascii files. The settings file must have the follow-
  25. ing format:
  26.  
  27.  
  28. *** INSTALLING ***
  29.  
  30. You only have to copy "TMDock" to any place you want. A good place would
  31. be "C:". Copy the default settings file or your own one to
  32. "S:TMDock.Prefs". You may also use a different name for the settings file
  33. but then you have to specify the filename whenever you start TMDock
  34. (e.g. "TMDock MyDir:MyTMDock.Prefs").
  35.  
  36.  
  37. *** SETTINGS ***
  38.  
  39. There are two types of lines: the "DOCK" line and the "PROG" line
  40.  
  41. * The "DOCK" line's template:
  42.  
  43.   NAME/A,X/N,Y/N,VERTICAL/S,COLUMNS/N,HOTKEY/K,TITLE/K,
  44.   TEXT/S,FRONTMOST/S,PATTERN/S,MENU/S,SCREEN/K
  45.  
  46.   Where:
  47.  
  48.   - NAME/A
  49.     The name for the Dock.
  50.  
  51.   - X/N,Y/N
  52.     The x/y position of the Dock. (Default is "0")
  53.  
  54.   - VERTICAL/S
  55.     If supplied a vertical Dock will be built. Otherwise a horizontal
  56.     dock will be built.
  57.  
  58.   - COLUMNS/N
  59.     The number of columns the Dock should have. If this is not supplied
  60.     the default depends on whether it's a vertical or a horizontal Dock.
  61.       Vertical:   default is the number of "PROG" lines given
  62.       Horizontal: default is "1"
  63.  
  64.   - HOTKEY/K
  65.     The hotkey that hides/showes the Dock. (Default is no hotkey)
  66.  
  67.   - TITLE/K
  68.     If supplied the Dock will have window borders and that title.
  69.     (Default is no title)
  70.  
  71.   - TEXT/S
  72.     If supplied the Dock will not show images but texts.
  73.     (Default is show images)
  74.  
  75.   - FRONTMOST/S
  76.     If supplied the Dock will open on the frontmost PublicScreen. This
  77.     switch overrides "SCREEN/K". (Default is open on default PublicScreen)
  78.  
  79.   - PATTERN/S
  80.     If supplied a pattern will be displayed around small images.
  81.     (Default is no pattern)
  82.  
  83.   - MENU/S
  84.     If supplied Dock will have a pull-down menu (to close Dock or quit
  85.     ToolManager). (Default is no menu)
  86.  
  87.   - SCREEN/K
  88.     The PublicScreen the Dock should open on.
  89.     (Default is to open on default PublicScreen)
  90.  
  91.  
  92. * The "PROG" line's template:
  93.  
  94.   NAME/A,COMMAND/K/A,AREXX/S,CLI/S,HOTKEY/S,WB/S,DIR/K,OUTPUT/K,KEY/K,ICON/K
  95.  
  96.   Where:
  97.  
  98.   - NAME/A
  99.     The name of the Dock item. This name is displayed if it's a TEXT Dock.
  100.  
  101.   - COMMAND/K/A
  102.     The command string the should be executed if item is selected.
  103.  
  104.   - AREXX/S, CLI/S, HOTKEY/S, WB/S
  105.     The type of the item. (Default is CLI)
  106.  
  107.   - DIR/K
  108.     The current directory of the executed command.
  109.  
  110.   - OUTPUT/K
  111.     Where should the output of the executed command go to?
  112.  
  113.   - KEY/K
  114.     The hotkey that should activate the item.
  115.  
  116.   - ICON
  117.     The path and filename of the icon that should be displayed if no
  118.     TEXT Dock.
  119.  
  120.  
  121. Please read the documentation for the "ToolManager" on how to create
  122. Docks.
  123.  
  124. To define a Dock you have to create a "DOCK" line and then as much "PROG"
  125. lines as you want. Repeat this procedure for every Dock you want. Note that
  126. no other lines are allowed!
  127.  
  128.  
  129. *** REQUIREMENTS ***
  130.  
  131. "TMDock" requires at least Kickstart/Workbench V2.04 and ToolManager V2.1
  132. installed ("toolmanager.library" V3).
  133. To run "TMDock" just type its name in a Shell window. The one and only
  134. argument you may supply is the name of settings file you want to use.
  135. If none supplied "S:TMDock.Prefs" will be used.
  136.  
  137.  
  138. *** COPYRIGHT ***
  139.  
  140. "TMDock" is Copyright by
  141.  
  142. Andreas Mair
  143. Karlsbader Str. 23
  144. D-86529 Schrobenhausen
  145.  Germany
  146.  
  147. E-Mail: amair@informatik.fh-augsburg.de
  148.  
  149.  
  150. "ToolManager" is Copyright by Stefan Becker.
  151.  
  152.  
  153. *** HISTORY ***
  154.  
  155. V1.00 (23.09.1996)
  156. ------------------
  157.  
  158.   first release. Very poor error handling!
  159.  
  160.